API endpoints

Water heaters

The base URL for all paths is https://create-energy-label.service.gov.uk. No authentication is required for any endpoints.

Conventional water heater: arrow image

Path

/api/v1/water-heaters/conventional-water-heaters/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
efficiencyRating	The energy efficiency class indicator. Must be one of: A+ A B C D E F	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+" }

Conventional water heater: energy label

You must display the label at the point of sale so that it’s easy to see and clearly related to the product. It must be at least 105mm x 200mm when printed.

Path

/api/v1/water-heaters/conventional-water-heaters/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
declaredLoadProfile	Declared load profile. Must be one of: 3XS XXS XS S M L XL XXL	String
efficiencyRating	Water heating energy efficiency class. Must be one of: A+ A B C D E F	String
consumptionUnit	How do you want to provide annual energy consumption? Must be one of: KWH GJ BOTH	String
kwhAnnum	Annual electricity consumption in kWh/annum. Only required if consumptionUnit is KWH or BOTH. This may be up to 4 digits long.	Integer
gjAnnum	Annual fuel consumption in GJ/annum. Only required if consumptionUnit is GJ or BOTH. This may be up to 2 digits long.	Integer
soundPowerLevelIndoors	Sound power level, indoors dB. This may be up to 2 digits long.	Integer
offPeak	Can the heater be set to work only during off-peak hours?	Boolean

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "declaredLoadProfile": "3XS", "efficiencyRating": "A+", "consumptionUnit": "KWH", "kwhAnnum": 1, "gjAnnum": 1, "soundPowerLevelIndoors": 1, "offPeak": true }

Heat pump water heater: arrow image

Path

/api/v1/water-heaters/heat-pump-water-heaters/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
efficiencyRating	The energy efficiency class indicator. Must be one of: A+ A B C D E F	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+" }

Heat pump water heater: energy label

You must display the label at the point of sale so that it’s easy to see and clearly related to the product. It must be at least 105mm x 200mm when printed.

Path

/api/v1/water-heaters/heat-pump-water-heaters/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
consumptionUnit	How do you want to provide annual energy consumption? Must be one of: KWH GJ BOTH	String
colderKwhAnnum	Annual electricity consumption in kWh/annum for colder climate conditions. Only required if consumptionUnit is KWH or BOTH. This may be up to 4 digits long.	Integer
averageKwhAnnum	Annual electricity consumption in kWh/annum for average climate conditions. Only required if consumptionUnit is KWH or BOTH. This may be up to 4 digits long.	Integer
warmerKwhAnnum	Annual electricity consumption in kWh/annum for warmer climate conditions. Only required if consumptionUnit is KWH or BOTH. This may be up to 4 digits long.	Integer
colderGjAnnum	Annual fuel consumption in GJ/annum for colder climate conditions. Only required if consumptionUnit is GJ or BOTH. This may be up to 2 digits long.	Integer
averageGjAnnum	Annual fuel consumption in GJ/annum for average climate conditions. Only required if consumptionUnit is GJ or BOTH. This may be up to 2 digits long.	Integer
warmerGjAnnum	Annual fuel consumption in GJ/annum for warmer climate conditions. Only required if consumptionUnit is GJ or BOTH. This may be up to 2 digits long.	Integer
declaredLoadProfile	Declared load profile. Must be one of: 3XS XXS XS S M L XL XXL	String
efficiencyRating	Water heating energy efficiency class. Must be one of: A+ A B C D E F	String
soundPowerLevelIndoors	Sound power level, indoors dB (optional). This may be up to 2 digits long.	Integer
soundPowerLevelOutdoors	Sound power level, outdoors dB. This may be up to 2 digits long.	Integer
canRunOffPeakOnly	Can the heat pump be set to work only during off-peak hours?	Boolean

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "consumptionUnit": "KWH", "colderKwhAnnum": 1, "averageKwhAnnum": 1, "warmerKwhAnnum": 1, "colderGjAnnum": 1, "averageGjAnnum": 1, "warmerGjAnnum": 1, "declaredLoadProfile": "3XS", "efficiencyRating": "A+", "soundPowerLevelIndoors": 1, "soundPowerLevelOutdoors": 1, "canRunOffPeakOnly": true }

Hot water storage tank: arrow image

Path

/api/v1/water-heaters/hot-water-storage-tanks/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
efficiencyRating	The energy efficiency class indicator. Must be one of: A+ A B C D E F	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+" }

Hot water storage tank: energy label

You must display the label at the point of sale so that it’s easy to see and clearly related to the product. It must be at least 105mm x 200mm when printed.

Path

/api/v1/water-heaters/hot-water-storage-tanks/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
efficiencyRating	Water heating energy efficiency class. Must be one of: A+ A B C D E F	String
standingLoss	Standing loss in watts (W). This may be up to 3 digits long.	Integer
volume	Volume of hot water storage tank in litres (l). This may be up to 3 digits long.	Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A+", "standingLoss": 1, "volume": 1 }

Package of a water heater and solar device: arrow image

Path

/api/v1/water-heaters/packages-of-water-heater-and-solar-device/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
efficiencyRating	The energy efficiency class indicator. Must be one of: A+++ A++ A+ A B C D E F G	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Package of a water heater and solar device: energy label

You must display the label at the point of sale so that it’s easy to see and clearly related to the product. It must be at least 210mm x 297mm when printed.

Path

/api/v1/water-heaters/packages-of-water-heater-and-solar-device/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
declaredLoadProfile	Declared load profile. Must be one of: 3XS XXS XS S M L XL XXL	String
heaterEfficiencyRating	Water heating energy efficiency class of the water heater. Must be one of: A+ A B C D E F G	String
packageEfficiencyRating	Water heating energy efficiency class of the package of water heater and solar device. Must be one of: A+++ A++ A+ A B C D E F G	String
solarCollector	Can a solar collector be included in this package?	Boolean
storageTank	Can a hot water storage tank be included in this package?	Boolean

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "declaredLoadProfile": "3XS", "heaterEfficiencyRating": "A+", "packageEfficiencyRating": "A+++", "solarCollector": true, "storageTank": true }

Packages of water heater and solar device: energy label calculator

You're responsible for making sure the energy label and fiche are calculated accurately. You must check the label and fiche carefully before you provide them to your customers.

Path

/api/v1/water-heaters/packages-of-water-heater-and-solar-device/calculate/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
waterHeatingEfficiencyPercentage	Water heating energy efficiency of water heater (%). This may be up to 3 digits long.	Integer
declaredLoadProfile	Declared load profile. Must be one of: M L XL XXL	String
storageTank	Is a hot water storage tank included in this package?	Boolean
annualNonSolarHeatContribution	Annual non-solar heat contribution (kWh). This may be up to 4 digits long.	Integer
auxElectricityConsumption	Auxiliary electricity consumption (kWh). This may be up to 4 digits long.	Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "waterHeatingEfficiencyPercentage": 1, "declaredLoadProfile": "M", "storageTank": true, "annualNonSolarHeatContribution": 1, "auxElectricityConsumption": 1 }

Packages of water heater and solar device: fiche

You're responsible for making sure the energy label and fiche are calculated accurately. You must check the label and fiche carefully before you provide them to your customers.

Path

/api/v1/water-heaters/packages-of-water-heater-and-solar-device/calculate/fiche

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
waterHeatingEfficiencyPercentage	Water heating energy efficiency of water heater (%). This may be up to 3 digits long.	Integer
declaredLoadProfile	Declared load profile. Must be one of: M L XL XXL	String
storageTank	Is a hot water storage tank included in this package?	Boolean
annualNonSolarHeatContribution	Annual non-solar heat contribution (kWh). This may be up to 4 digits long.	Integer
auxElectricityConsumption	Auxiliary electricity consumption (kWh). This may be up to 4 digits long.	Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "waterHeatingEfficiencyPercentage": 1, "declaredLoadProfile": "M", "storageTank": true, "annualNonSolarHeatContribution": 1, "auxElectricityConsumption": 1 }

Solar water heater: arrow image

Path

/api/v1/water-heaters/solar-water-heaters/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
efficiencyRating	The energy efficiency class indicator. Must be one of: A+ A B C D E F	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+" }

Solar water heater: energy label

You must display the label at the point of sale so that it’s easy to see and clearly related to the product. It must be at least 105mm x 200mm when printed.

Path

/api/v1/water-heaters/solar-water-heaters/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
consumptionUnit	How do you want to provide annual energy consumption? Must be one of: KWH GJ BOTH	String
colderKwhAnnum	Annual electricity consumption in kWh/annum for colder climate conditions. Only required if consumptionUnit is KWH or BOTH. This may be up to 4 digits long.	Integer
averageKwhAnnum	Annual electricity consumption in kWh/annum for average climate conditions. Only required if consumptionUnit is KWH or BOTH. This may be up to 4 digits long.	Integer
warmerKwhAnnum	Annual electricity consumption in kWh/annum for warmer climate conditions. Only required if consumptionUnit is KWH or BOTH. This may be up to 4 digits long.	Integer
colderGjAnnum	Annual fuel consumption in GJ/annum for colder climate conditions. Only required if consumptionUnit is GJ or BOTH. This may be up to 2 digits long.	Integer
averageGjAnnum	Annual fuel consumption in GJ/annum for average climate conditions. Only required if consumptionUnit is GJ or BOTH. This may be up to 2 digits long.	Integer
warmerGjAnnum	Annual fuel consumption in GJ/annum for warmer climate conditions. Only required if consumptionUnit is GJ or BOTH. This may be up to 2 digits long.	Integer
declaredLoadProfile	Declared load profile. Must be one of: 3XS XXS XS S M L XL XXL	String
efficiencyRating	Water heating energy efficiency class. Must be one of: A+ A B C D E F	String
soundPowerLevelIndoors	Sound power level, indoors dB. This may be up to 2 digits long.	Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "consumptionUnit": "KWH", "colderKwhAnnum": 1, "averageKwhAnnum": 1, "warmerKwhAnnum": 1, "colderGjAnnum": 1, "averageGjAnnum": 1, "warmerGjAnnum": 1, "declaredLoadProfile": "3XS", "efficiencyRating": "A+", "soundPowerLevelIndoors": 1 }